gridpack::mapper::GenVectorMap< _network > Class Template Reference

#include <gen_vector_map.hpp>

Collaboration diagram for gridpack::mapper::GenVectorMap< _network >:

[legend]

List of all members.

Public Member Functions
	GenVectorMap (boost::shared_ptr< _network > network)
	~GenVectorMap ()
boost::shared_ptr < gridpack::math::Vector >	mapToVector (void)
gridpack::math::Vector *	intMapToVector (void)
void	mapToVector (gridpack::math::Vector &vector)
void	mapToVector (boost::shared_ptr< gridpack::math::Vector > &vector)
void	mapToNetwork (const gridpack::math::Vector &vector)
void	mapToNetwork (boost::shared_ptr< gridpack::math::Vector > &vector)

template<class _network>
class gridpack::mapper::GenVectorMap< _network >

---

Constructor & Destructor Documentation

template<class _network >

gridpack::mapper::GenVectorMap< _network >::GenVectorMap

(

boost::shared_ptr< _network >

network

)

Initialize mapper for the given network and the current mode. Create global arrays that contain offsets that will be used to create vector from the network component objects

Parameters:

network

network that will generate vector

template<class _network >

gridpack::mapper::GenVectorMap< _network >::~GenVectorMap

(

)

---

Member Function Documentation

template<class _network >

gridpack::math::Vector* gridpack::mapper::GenVectorMap< _network >::intMapToVector

(

void

)

Generate vector from current component state on network and return a conventional pointer to it. Used for Fortran interface.

Returns:

return a pointer to new vector

template<class _network >

void gridpack::mapper::GenVectorMap< _network >::mapToNetwork

(

boost::shared_ptr< gridpack::math::Vector > &

vector

)

Push data from vector onto buses and branches. Vector must be created with the mapToVector method using the same GenVectorMap

Parameters:

vector

vector containing data to be pushed to network

References gridpack::mapper::GenVectorMap< _network >::mapToNetwork().

template<class _network >

void gridpack::mapper::GenVectorMap< _network >::mapToNetwork

(

const gridpack::math::Vector &

vector

)

Push data from vector onto buses and branches. Vector must be created with the mapToVector method using the same GenVectorMap

Parameters:

vector

vector containing data to be pushed to network

template<class _network >

void gridpack::mapper::GenVectorMap< _network >::mapToVector

(

boost::shared_ptr< gridpack::math::Vector > &

vector

)

Reset existing vector from current component state on network

Parameters:

vector

existing vector (should be generated from same mapper)

References gridpack::mapper::GenVectorMap< _network >::mapToVector().

template<class _network >

void gridpack::mapper::GenVectorMap< _network >::mapToVector

(

gridpack::math::Vector &

vector

)

Reset existing vector from current component state on network

Parameters:

vector

existing vector (should be generated from same mapper)

template<class _network >

boost::shared_ptr<gridpack::math::Vector> gridpack::mapper::GenVectorMap< _network >::mapToVector

(

void

)

Generate vector from current component state on network

Returns:

return a pointer to new vector

---

The documentation for this class was generated from the following file:

• gen_vector_map.hpp